REST Services Changes for 4.39
The following changes have been made to REST Services for 4.39.
 REST Services added
REST Services added
                                                    The following REST Services have been added.
| REST Service | URL | Verb | 
|---|---|---|
| Get current academic year start/end dates | <web services URL>/Cohorts/GetCurrentAcademicYear | GET | 
| Search for Learner ILPs matching cohort filter parameters | <web services URL>/ILPDefinitionInstances/AdminLearnerILPSearchByFilter | POST | 
| Search for Learner ILPs by learner or staff name or ILP name | <web services URL>/ILPDefinitionInstances/AdminLearnerILPSearch | POST | 
| Create ILP Instance Staff | <web services URL>/ILPDefinitionInstances/CreateIlpInstanceStaff | POST | 
| Get ILP definition learner instance counts by Id | <web services URL>/ILPDefinitionInstances/GetILPDefinitionInstanceStats/{ilpId} | GET | 
| Get summary of an ILP instance for a learner | <web services URL>/ILPDefinitionInstances/GetILPLearnerInstance/{ilpInstanceId} | GET | 
| Save ILP Review Instance Header Snapshot | <web services URL>/ILPLearnerReviews/SaveILPReviewHeaderSnapshot/{id} | PUT | 
| Upload Review Attachment | <web services URL>/ILPLearnerReviews/UploadReviewAttachment | POST | 
| Get ILP Review Attachments | <web services URL>/ILPLearnerReviews/GetILPReviewAttachments?reviewId={reviewId} | GET | 
| Get Blob By Id | <web services URL>/ILPLearnerReviews/GetILPReviewAttachment?blobId={blobId} | GET | 
| Get Review Attachments For Learner | <web services URL>/ILPLearnerReviews/GetAllReviewAttachmentsForLearner | GET | 
| Get Learner Review Attachments For Tutor | <web services URL>/ILPLearnerReviews/GetLearnerReviewAttachmentsForTutor/{learnerId} | GET | 
| Delete ILP Review Attachment | <web services URL>/ILPLearnerReviews/DeleteReviewBlobById/{blobId} | DELETE | 
| Upload Target Attachment | <web services URL>/ILPLearnerTargets/UploadTargetAttachment | POST | 
| Get ILP Target Attachments | <web services URL>/ILPLearnerTargets/GetILPTargetAttachments?targetId={targetId} | GET | 
| Get Blob By Id | <web services URL>/ILPLearnerTargets/GetILPTargetAttachment?blobId={blobId} | GET | 
| Delete ILP Target Attachment | <web services URL>/ILPLearnerTargets/DeleteTargetBlobById/{blobId} | DELETE | 
| Get Target Attachments For Learner | <web services URL>/ILPLearnerTargets/GetAllTargetAttachmentsForLearner | GET | 
| Get ILP Target Attachments | <web services URL>/ILPLearnerTargets/GetLearnerTargetAttachmentsForTutor/{learnerId} | GET | 
| Get list of question sections | <web services URL>/ILPQuestions/GetSections | GET | 
| Get category id for a question section | <web services URL>/ILPQuestions/GetSectionCategory | GET | 
| Retrieves a summary of a learners ILP | <web services URL>/ILPTutorDashboard/GetFullILPSummary/{ilpDefinitionInstanceId} | GET | 
| Update ILP review and target statuses | <web services URL>/ILPTutorDashboard/BulkUpdateILPStatus | PUT | 
| Cancel or Rearrange Interview Booking | <web services URL>/Interview/LearnerCancelRearrangeInterview | PUT | 
| Get Report Path List | <web services URL>/ReportsItemReport/GetReportPathList | GET | 
| Upload Report File | <web services URL>/ReportsItemReport/UploadReportFile | POST | 
| Email Report | <web services URL>/ReportsItemReport/EmailReport | POST | 
| Get User Personas | <web services URL>/Roles/UserPersonas | GET | 
| Create category | <web services URL>/SFGCategories/CreateCategory | POST | 
| Update safeguarding category | <web services URL>/SFGCategories/UpdateCategory | PUT | 
| Change safeguarding category Active State | <web services URL>/SFGCategories/UpdateCategoryStatus | PUT | 
| Delete safeguarding category | <web services URL>/SFGCategories/DeleteCategory/{categoryId} | DELETE | 
| Get safeguarding category by Id | <web services URL>/SFGCategories/GetCategory/{categoryId} | GET | 
| Get safeguarding categories | <web services URL>/SFGCategories/GetCategories?activeOnly={activeOnly} | GET | 
| Get safeguarding distribution list by Id | <web services URL>/SFGDistributionLists/GetDistributionList/{id} | GET | 
| Create distribution list | <web services URL>/SFGDistributionLists/CreateDistributionList | POST | 
| Update safeguarding distribution list | <web services URL>/SFGDistributionLists/UpdateDistributionList | PUT | 
| Get safeguarding distribution lists | <web services URL>/SFGDistributionLists/GetDistributionLists?activeOnly={activeOnly} | GET | 
| Change safeguarding distribution list Active State | <web services URL>/SFGDistributionLists/UpdateDistributionListStatus | PUT | 
| Delete safeguarding distribution list | <web services URL>/SFGDistributionLists/DeleteDistributionList/{id} | DELETE | 
| Get list of EBS group definitions | <web services URL>/SFGDistributionLists/GetGroupDefinitions | GET | 
| Get list of EBS study locations | <web services URL>/SFGDistributionLists/GetStudyLocations | GET | 
| Get list of EBS organisation units | <web services URL>/SFGDistributionLists/GetOrganisationUnits | GET | 
| Get list of EBS primary roles | <web services URL>/SFGDistributionLists/GetPrimaryRoles | GET | 
| Get list of EBS staff members | <web services URL>/SFGDistributionLists/GetStaffList | GET | 
 CDR REST Services changes
CDR REST Services changes
                                                    The following changes have been made to REST Services to support requirements for institutions in Northern Ireland:
The following fields have been added to the PeopleCDRDetails section of Create Person (POST) and Update Person (PUT):
- 
                                                                GCSE_A_C 
- 
                                                                GCSE_D_G 
- 
                                                                CareLeaver 
The following fields have been added to the EnrolmentCDRMessage section of Create Enrolment (POST) and Update Enrolment (PUT):
- 
                                                                HLAPathway 
The following fields have been added to the UIOCDR section of Create Unit Instance Occurrence (POST) and Update Unit Instance Occurrence (PUT):
- 
                                                                HECOSCode 
- 
                                                                HLAPathway 
 HESA REST Services changes
HESA REST Services changes
                                                    The following changes have been made to REST Services for the HESA Alternative Return:
The Disabilities section, containing the following fields, has been added to Create Person (POST):
- 
                                                                Id 
- 
                                                                DisabilityType 
- 
                                                                PersonCode 
- 
                                                                StartDate 
- 
                                                                EndDate 
- 
                                                                ShortDescription 
- 
                                                                LongDescription 
- 
                                                                SpecialExamNeeds 
- 
                                                                AssessmentId 
- 
                                                                PrimaryNeed 
- 
                                                                NotesId 
- 
                                                                RequiresAssistance 
- 
                                                                IncludeInReturn 
- 
                                                                User1 
- 
                                                                User2 
- 
                                                                User3 
- 
                                                                User4 
- 
                                                                User5 
- 
                                                                User6 
- 
                                                                User7 
- 
                                                                User8 
- 
                                                                User9 
- 
                                                                User10 
- 
                                                                User11 
- 
                                                                User12 
- 
                                                                User13 
- 
                                                                User14 
- 
                                                                User15 
- 
                                                                User16 
- 
                                                                User17 
- 
                                                                User18 
- 
                                                                User19 
- 
                                                                User20 
- 
                                                                User21 
- 
                                                                User22 
- 
                                                                User23 
- 
                                                                User24 
- 
                                                                User25 
- 
                                                                User26 
- 
                                                                User27 
- 
                                                                User28 
- 
                                                                User29 
- 
                                                                User30 
- 
                                                                User31 
- 
                                                                User32 
- 
                                                                SupportNotesId 
- 
                                                                SupportNotes 
- 
                                                                Topic